Hybris UX Api
List billingAccount (Debt check)
This operation retrieves a BillingAccount entity and provides billing account details along with debt information based on customer identity or SSN or location Id.
Request
URL
http://[localhost]:[port]/ecom-ux/v1/{businessId}/billingAccountHeader
| name | value | description | required |
|---|---|---|---|
| client-id | string | The client-id identifying the channel. Minimum characters: 5 | Y |
| client-secret | string | Password associated with the client-id. Minimum characters: 5 | Y |
| Correlation-ID | string | Identifier that correlates HTTP request between a client and server. Any identification model (UUDI, checksum, etc.) can be used, as long as it is a unique value to differentiate a transaction. | N |
| channeId | string | Channel to business: default value: "ECOM". | M/O |
| lob | string | The Line of Business Identifier currently available are: FIXED enum: ["FIXED", "PREPAID", "POSTPAID"]. Not in scope for PA | N |
| x-tax-identifier | string | Need to pass SSN in encrypted format example: "cUakaigzngOwnjhw8MK/HQ==" Note: To fetch Account (debit check) details by SSN. This header is mandatory for PR Market only for SSN-based search only | M for PR market |
Query Param
| name | type | description | required |
|---|---|---|---|
| fields | string | Comma-separated properties to provide in response. Note: Not in Scope | N |
| identityType | string | Identifier Type, “C” or “PP” for Costa Rica C – Cedula PP- passport Note: it is optional query param as per design. it is Mandatory query param for PA, JM, CR as per code. -Possible Identity types for Liberate JM are PP (passport), NI (National Id), OT (Other), SS (Driving L No), TR (TRN Number) -Possible Identity types for Liberate PA are C -Cedula, PP-Pasaporte, SS-Seguro Social, V-Cuenta Vieja - for B2B JM and PA , companies identityType can be AA (Articles of Association),BL(Trade/Business License), OT (Other) and CI(Certificate of Incorporation) and Not in scope for now. -TR is the default identityType used in Cerillion(JM). | N |
| identityNumber | string | Customer identity document number like Cedula number Note: it is optional query param as per design.it is Mandatory query param for PA, CR, JM as per code | N |
| balanceCheck | Boolean | Flag for customer account debt information. API will return customer accounts balance if this flag is true. Used in PA and JM market. | N |
| locationId | string | Need to pass customer location id example: "00913000000228" Note: To fetch the account (debit check) details by location Id, this query param is mandatory for PR Market | M for PR market |
Possible response success
Response for PR
From this operation we can fetch Auto Pay is enabled or disabled, auto pay date and day, Delinquency status, payment status and payment method EFT or Card
Note In the response if PaymentPlan.planType is AutoPay Enable, AutoPay Date can be dislpayed in the extended Characteristics else AutoPay Date cannot be displayed.
Debit Check based on SSN:
AutoPay Date Enable
[
{
"id": "8211990010009223",
"name": "TIVO APP TEST LIBERTY GO",
"@type": "BillingAccount",
"accountType": "RES",
"state": "E",
"paymentStatus": "E",
"paymentPlan": [
{
"planType": "Auto Pay Enable"
}
],
"accountBalance": [
{
"amount": {
"unit": "USD",
"value": -135.33
},
"balanceType": "AccountBalance",
"validFor": {
"startDateTime": "2022-12-13T00:00:00.000Z",
"endDateTime": "2023-01-12T00:00:00.000Z"
}
},
{
"amount": {
"unit": "USD",
"value": 0.00
},
"balanceType": "DelinquentBalance"
}
],
"creditLimit": {
"unit": "USD",
"value": 100.00
},
"contact": [
{
"contactName": "TIVO APP TEST LIBERTY GO",
"contactMedium": [
{
"mediumType": "Address",
"preferred": true,
"characteristic": {
"contactType": "BillingAddress",
"stateOrProvince": "PR",
"city": "SAN JUAN",
"street1": "279 AVE PONCE DE LEON",
"street2": "APT 8",
"postCode": "009171920"
}
},
{
"mediumType": "Phone",
"characteristic": {
"contactType": "Home",
"phoneNumber": "7879257001"
}
}
]
}
],
"relatedParty": [
{
"id": "1101520693636",
"name": "TIVO APP TEST LIBERTY GO",
"role": "Customer",
"@referredType": "Individual"
}
],
"characteristic": [
{
"name": "autoPayDate",
"value": "2023-01-07T00:00:00.000Z"
},
{
"name": "DebitDay",
"value": "03"
},
{
"name": "CreditScore",
"value": "A"
},
{
"name": "LocationId",
"value": "00917192000912"
}
]
}
]AutoPay Date Disable
[
{
"id": "8211990010009223",
"name": "TIVO APP TEST LIBERTY GO",
"@type": "BillingAccount",
"accountType": "RES",
"state": "E",
"paymentStatus": "E",
"paymentPlan": [
{
"planType": "Auto Pay Disable"
}
],
"accountBalance": [
{
"amount": {
"unit": "USD",
"value": -135.33
},
"balanceType": "AccountBalance",
"validFor": {
"startDateTime": "2022-12-13T00:00:00.000Z",
"endDateTime": "2023-01-12T00:00:00.000Z"
}
},
{
"amount": {
"unit": "USD",
"value": 0.00
},
"balanceType": "DelinquentBalance"
}
],
"creditLimit": {
"unit": "USD",
"value": 100.00
},
"contact": [
{
"contactName": "TIVO APP TEST LIBERTY GO",
"contactMedium": [
{
"mediumType": "Address",
"preferred": true,
"characteristic": {
"contactType": "BillingAddress",
"stateOrProvince": "PR",
"city": "SAN JUAN",
"street1": "279 AVE PONCE DE LEON",
"street2": "APT 8",
"postCode": "009171920"
}
},
{
"mediumType": "Phone",
"characteristic": {
"contactType": "Home",
"phoneNumber": "7879257001"
}
}
]
}
],
"relatedParty": [
{
"id": "1101520693636",
"name": "TIVO APP TEST LIBERTY GO",
"role": "Customer",
"@referredType": "Individual"
}
],
"characteristic": [
{
"name": "CreditScore",
"value": "A"
},
{
"name": "LocationId",
"value": "00917192000912"
}
]
}
]Debit Check based on Location ID:
[
{
"id": "8211990010002467",
"@type": "BillingAccount",
"state": "NORMAL",
"paymentStatus": "NORMAL",
"accountType": "RES",
"accountBalance": [
{
"amount": {
"unit": "USD",
"value": 0.00
},
"balanceType": "AccountBalance"
},
{
"amount": {
"unit": "USD",
"value": 0.00
},
"balanceType": "DelinquentBalance"
}
],
"relatedParty": [
{
"id": "1101519016245",
"role": "Customer",
"@referredType": "Individual"
}
],
"characteristic": [
{
"valueType": "string",
"value": "913000000228",
"name": "locationId"
}
]
},
{
"id": "8211990010002517",
"@type": "BillingAccount",
"state": "NORMAL",
"paymentStatus": "NORMAL",
"accountType": "RES",
"accountBalance": [
{
"amount": {
"unit": "USD",
"value": 0.00
},
"balanceType": "AccountBalance"
},
{
"amount": {
"unit": "USD",
"value": 0.00
},
"balanceType": "DelinquentBalance"
}
],
"relatedParty": [
{
"id": "1101519020833",
"role": "Customer",
"@referredType": "Individual"
}
],
"characteristic": [
{
"valueType": "string",
"value": "913000000228",
"name": "locationId"
}
]
},
{
"id": "8211990010002616",
"@type": "BillingAccount",
"state": "NORMAL",
"paymentStatus": "NORMAL",
"accountType": "RES",
"accountBalance": [
{
"amount": {
"unit": "USD",
"value": 0.00
},
"balanceType": "AccountBalance"
},
{
"amount": {
"unit": "USD",
"value": 0.00
},
"balanceType": "DelinquentBalance"
}
],
"relatedParty": [
{
"id": "1101519021658",
"role": "Customer",
"@referredType": "Individual"
}
],
"characteristic": [
{
"valueType": "string",
"value": "913000000228",
"name": "locationId"
}
]
},
{
"id": "8211990010002681",
"@type": "BillingAccount",
"state": "NORMAL",
"paymentStatus": "NORMAL",
"accountType": "RES",
"accountBalance": [
{
"amount": {
"unit": "USD",
"value": 0.00
},
"balanceType": "AccountBalance"
},
{
"amount": {
"unit": "USD",
"value": 0.00
},
"balanceType": "DelinquentBalance"
}
],
"relatedParty": [
{
"id": "1101519029354",
"role": "Customer",
"@referredType": "Individual"
}
],
"characteristic": [
{
"valueType": "string",
"value": "913000000228",
"name": "locationId"
}
]
},
{
"id": "8211990010002749",
"@type": "BillingAccount",
"state": "NORMAL",
"paymentStatus": "NORMAL",
"accountType": "RES",
"accountBalance": [
{
"amount": {
"unit": "USD",
"value": 0.00
},
"balanceType": "AccountBalance"
},
{
"amount": {
"unit": "USD",
"value": 0.00
},
"balanceType": "DelinquentBalance"
}
],
"relatedParty": [
{
"id": "1101519029594",
"role": "Customer",
"@referredType": "Individual"
}
],
"characteristic": [
{
"valueType": "string",
"value": "913000000228",
"name": "locationId"
}
]
},
{
"id": "8211990010002921",
"@type": "BillingAccount",
"state": "NORMAL",
"paymentStatus": "NORMAL",
"accountType": "RES",
"accountBalance": [
{
"amount": {
"unit": "USD",
"value": 0.00
},
"balanceType": "AccountBalance"
},
{
"amount": {
"unit": "USD",
"value": 0.00
},
"balanceType": "DelinquentBalance"
}
],
"relatedParty": [
{
"id": "1101519033869",
"role": "Customer",
"@referredType": "Individual"
}
],
"characteristic": [
{
"valueType": "string",
"value": "913000000228",
"name": "locationId"
}
]
},
{
"id": "8211990010003069",
"@type": "BillingAccount",
"state": "NORMAL",
"paymentStatus": "NORMAL",
"accountType": "RES",
"accountBalance": [
{
"amount": {
"unit": "USD",
"value": 0.00
},
"balanceType": "AccountBalance"
},
{
"amount": {
"unit": "USD",
"value": 0.00
},
"balanceType": "DelinquentBalance"
}
],
"relatedParty": [
{
"id": "1101519038223",
"role": "Customer",
"@referredType": "Individual"
}
],
"characteristic": [
{
"valueType": "string",
"value": "913000000228",
"name": "locationId"
}
]
}
]Response for CR
[
{
"id": "855651",
"name": "YORLENI ALEJANDRA CASTILLO CORDERO",
"@type": "BillingAccount",
"state": "Active",
"accountBalance": [
{
"amount": {
"unit": "CRC",
"value": 185346
},
"balanceType": "CABLE TICA"
},
{
"amount": {
"unit": "CRC",
"value": 61377
},
"balanceType": "INTERNET"
},
{
"amount": {
"unit": "CRC",
"value": 246723
},
"balanceType": "AccountBalance"
}
],
"contact": [
{
"contactName": "YORLENI ALEJANDRA CASTILLO CORDERO",
"contactMedium": [
{
"mediumType": "Address",
"characteristic": {
"contactType": "BillingAddress",
"stateOrProvince": "SAN JOSE",
"city": "SAN JOSE",
"street1": "HATILLO 8",
"street2": "HATILLO"
}
}
]
}
],
"relatedParty": [
{
"id": "1-101T72F",
"name": "YORLENI ALEJANDRA CASTILLO CORDERO",
"role": "Customer",
"@referredType": "Individual"
}
]
}
]Request for JM
http://[localhost]:[port]/ecom-ux/v1/JM/billingAccount?balanceCheck=true&identityNumber=105511161&identityType=TRResponse for JM Debt check using Identity. Fields which are part of this example are only in scope for JM Debt check response.
Liberate Response
[
{
"id": "313908320000",
"@type": "BillingAccount",
"href": "https://esb.lla.com/tmf-api/accountManagement/v4/billingAccount/313908320000",
"name": "MR Chevaughn Williams",
"state": "A",
"accountBalance": [
{
"amount": {
"unit": "JMD",
"value": 0.00
},
"balanceType": "TotalOutstandingBalance"
},
{
"amount": {
"unit": "JMD",
"value": 0.00
},
"balanceType": "OverdueBalance"
},
{
"amount": {
"unit": "JMD",
"value": 0.00
},
"balanceType": "WriteOffAmount"
},
{
"amount": {
"unit": "JMD",
"value": 0.00
},
"balanceType": "LastPaymentAmount",
"validFor": {
"endDateTime": "1858-11-17T12:00:00Z"
}
},
{
"amount": {
"unit": "JMD",
"value": 0.00
},
"balanceType": "PaymentPlanBalance"
},
{
"amount": {
"unit": "JMD",
"value": 0.00
},
"balanceType": "PaymentPlanAmount"
}
],
"contact": [
{
"contactName": "MR Chevaughn Williams",
"contactMedium": [
{
"mediumType": "BillingAddress",
"characteristic": {
"street1": "514 Claremount Blvd,Old Harbour"
}
}
]
}
],
"characteristic": [
{
"name": "DateOfBirth",
"value": "2001-06-09T12:00:00Z"
},
{
"name": "Nationality",
"value": ""
},
{
"name": "BillingIndicator",
"value": "Y"
}
],
"paymentStatus": "Active"
}
]Cerillion Response
[
{
"id": "50465636",
"href": "https://esb-dev.lla.com/tmf-api/accountManagement/v1/JM/billingAccount/50465636",
"name": "KEREISHA STEWART",
"state": "SN",
"relatedParty": [
{
"@referredType": "Customer",
"id": "328115"
}
],
"accountType": "RES",
"billStructure": {
"presentationMedia": [
{
"id": "E",
"name": "EMAIL"
}
]
},
"contact": [
{
"contactName": "MARCIA OATES",
"contactType": "",
"contactMedium": [
{
"mediumType": "BillingAddress",
"characteristic": {
"street2": "WARD AVENUE",
"city": "GREENVALE",
"stateOrProvince": "MANDEVILLE",
"country": "Jamaica",
"postCode": "00000"
}
},
{
"mediumType": "Telephone",
"characteristic": {
"contactType": "MOBILE_NO",
"phoneNumber": "8765731215"
}
},
{
"mediumType": "Email",
"characteristic": {
"emailAddress": "kereishastewart86@gmail.com"
}
},
{
"mediumType": "Alternative Email",
"characteristic": {
"emailAddress": "kereishastewart86@gmail.com"
}
}
]
}
],
"accountBalance": [
{
"amount": {
"unit": "JMD",
"value": 2400.0
},
"balanceType": "LastPaymentAmount",
"validFor": {
"endDateTime": "2021-10-11T00:00:00Z"
}
},
{
"amount": {
"unit": "JMD",
"value": -38.07
},
"balanceType": "CurrentBalance"
},
{
"amount": {
"unit": "JMD",
"value": 0.0
},
"balanceType": "OverdueBalance"
},
{
"amount": {
"unit": "JMD",
"value": 0.0
},
"balanceType": "TotalOutstandingBalance"
},
{
"amount": {
"unit": "JMD",
"value": -38.07
},
"balanceType": "LastBillAmount",
"validFor": {
"endDateTime": "2022-03-08T00:00:00Z"
}
}
],
"paymentStatus": "Active"
},
{
"id": "50034365",
"href": "https://esb-dev.lla.com/tmf-api/accountManagement/v1/JM/billingAccount/50034365",
"name": "KEREISHA STEWART",
"state": "SW",
"relatedParty": [
{
"@referredType": "Customer",
"id": "328115"
}
],
"accountType": "RES",
"billStructure": {
"presentationMedia": [
{
"id": "N",
"name": "NOBILLAUTO"
}
]
},
"contact": [
{
"contactName": "KEREISHA STEWART",
"contactType": "primary",
"contactMedium": [
{
"mediumType": "BillingAddress",
"characteristic": {
"street2": "FISHER ROAD",
"stateOrProvince": "MANDEVILLE",
"country": "Jamaica",
"postCode": "00000"
}
},
{
"mediumType": "Telephone",
"characteristic": {
"contactType": "HOME",
"phoneNumber": "5617353"
}
},
{
"mediumType": "Email",
"characteristic": {
"emailAddress": "kereishastewart86@gmail.com"
}
},
{
"mediumType": "Alternative Email",
"characteristic": {
"emailAddress": "kereishastewart86@gmail.com"
}
}
]
}
],
"accountBalance": [
{
"amount": {
"unit": "JMD",
"value": 10542.0
},
"balanceType": "LastPaymentAmount",
"validFor": {
"endDateTime": "2014-04-16T00:00:00Z"
}
},
{
"amount": {
"unit": "JMD",
"value": 0.0
},
"balanceType": "CurrentBalance"
},
{
"amount": {
"unit": "JMD",
"value": 0.0
},
"balanceType": "OverdueBalance"
},
{
"amount": {
"unit": "JMD",
"value": 0.0
},
"balanceType": "TotalOutstandingBalance"
},
{
"amount": {
"unit": "JMD",
"value": 0.0
},
"balanceType": "LastBillAmount",
"validFor": {
"endDateTime": "2014-10-28T00:00:00Z"
}
}
],
"paymentStatus": "Active"
}
]Request for PA
http://[localhost]:[port]/ecom-ux/v1/PA/billingAccount?balanceCheck=true&identityNumber=8-449-920&identityType=PPResponse for PA Debt check using Identity. Fields which are part of this example are only in scope for PA Debt check response.
[
{
"id": "101000130000",
"@type": "BillingAccount",
"href": "https://host:port/telco-api/accountManagement/v4/account/101000130000",
"name": "Jessica Lizbeth Navarro Polo",
"state": "W",
"accountBalance": [
{
"amount": {
"unit": "PAB",
"value": 5.97
},
"balanceType": "TotalOutstandingBalance"
},
{
"amount": {
"unit": "PAB",
"value": 5.97
},
"balanceType": "OverdueBalance"
},
{
"amount": {
"unit": "PAB",
"value": 0.00
},
"balanceType": "WriteOffAmount"
},
{
"amount": {
"unit": "PAB",
"value": 23.40
},
"balanceType": "LastPaymentAmount",
"validFor": {
"endDateTime": "2005-09-10T12:12:41Z"
}
},
{
"amount": {
"unit": "PAB",
"value": 0.00
},
"balanceType": "PaymentPlanBalance"
},
{
"amount": {
"unit": "PAB",
"value": 0.00
},
"balanceType": "PaymentPlanAmount"
}
],
"contact": [
{
"contactName": "Jessica Lizbeth Navarro Polo",
"contactMedium": [
{
"mediumType": "BillingAddress",
"characteristic": {
"street1": "PANAMA TOCUMEN,URB PARQUE REAL AVE SAN MARINO,CASA C 11"
}
}
]
}
],
"characteristic": [
{
"name": "DateOfBirth",
"value": "1975-12-03T12:00:00Z"
},
{
"name": "Nationality",
"value": "PANA"
},
{
"name": "BillingIndicator",
"value": "Y"
}
],
"paymentStatus": "Inarrears"
}
]Request for PA
http://[localhost]:[port]/ecom-ux/v1/PA/billingAccount?balanceCheck=false&identityNumber=8-449-920&identityType=PPResponse for PA when balanceCheck is false
[
{
"id": "101000130000",
"href": "https://host:port/telco-api/accountManagement/v4/account/101000130000",
"name": "Jessica Lizbeth Navarro Polo",
"state": "W",
"@type": "BillingAccount"
}
]Definitions
Each of the response parameters are detailed.
| Field name | Datatype | description | required |
|---|---|---|---|
| id | string | Unique identifier of the account | N |
| href | string | Unique reference of the account | N |
| accountType | string | A categorization of an account, such as individual, joint, and so forth, whose instances share some of the same characteristics. Note: for flexibility we use a String here but an implementation may use an enumeration with a limited list of valid values | N |
| description | string | Detailed description of the party account | N |
| lastModified | datetime | Date of last modification of the account | N |
| name | string | Name of the account | N |
| paymentStatus | string | The condition of the account, such as due, paid, Inarrears, Active | N |
| ratingType | string | Indicates whether the account follows a specific payment option such as prepaid or postpaid | N |
| state | string | Contains the lifecycle state such as: Active, Closed, Suspended and so on. Possible values are W – working C – Ceased A – Allocated D - Default E – WrittenOff F - Closed. For cerillion, common values are SN (status normal), SW (Written Off), SF (status final) | N |
| accountBalance | object Array | Balances linked to the account | N |
| accountBalance.balanceType | string | Type of the balance ; deposit balance, disputed balance, loyalty balance, receivable balance. For JM Market, possible balanceTypes are TotalOutstandingBalance, OverdueBalance, WriteOffAmount, LastPaymentAmount, PaymentPlanBalance, PaymentPlanAmount for Liberate and for cerillion, LastPaymentAmount, OverdueBalance, CurrentBalance and LastBillAmount | N |
| accountBalance.amount | object | Balance amount | N |
| accountBalance.amount.unit | string | Currency (ISO4217 norm uses 3 letters to define the currency) | N |
| accountBalance.amount.value | number, float | A positive floating point number | N |
| accountBalance.validFor | object | 'A period of time, either as a deadline (endDateTime only) a startDateTime only, or both | N |
| accountBalance.validFor.endDateTime | datetime | End of the time period, using IETC-RFC-3339 format | N |
| accountBalance.validFor.startDateTime | datetime | Start of the time period, using IETC-RFC-3339 format. NA for JM. | N |
| accountBalance.@baseType | string | When sub-classing, this defines the super-class | N |
| accountBalance.@schemaLocation | string | A URI to a JSON-Schema file that defines additional attributes and relationships | N |
| accountBalance.@type | string | When sub-classing, this defines the sub-class entity name | N |
| accountRelationship | object Array | Significant connection between accounts. For instance an aggregating account for a list of shop branches each having its own billing account | N |
| accountRelationship.relationshipType | string | Type of relationship. | N |
| accountRelationship.account | object | .An account may be a party account or a financial account. | N |
| accountRelationship.account.id | string | Unique identifier Id of the EntityDescriptionRef. | N |
| accountRelationship.account.href | string | Unique reference of the EntityDescriptionRef | N |
| accountRelationship.account.description | string | Detailed description of the EntityDescriptionRef | N |
| accountRelationship.account.name | string | Name of the account. | N |
| accountRelationship.account.@baseType | string | When sub-classing, this defines the super-class | N |
| accountRelationship.account.@schemaLocation | string | A URI to a JSON-Schema file that defines additional attributes and relationships | N |
| accountRelationship.account.@type | string | When sub-classing, this defines the sub-class entity name | N |
| accountRelationship.account.@referredType | string | The actual type of the target instance when needed for disambiguation | N |
| accountRelationship.validFor | accountBalance.validFor | 'A period of time, either as a deadline (endDateTime only) a startDateTime only, or both | N |
| accountRelationship.@baseType | string | When sub-classing, this defines the super-class | N |
| accountRelationship.@schemaLocation | string | A URI to a JSON-Schema file that defines additional attributes and relationships | N |
| accountRelationship.@type | string | When sub-classing, this defines the sub-class entity name | N |
| billStructure | object | The structure of the bill for party accounts (billing or settlement). | N |
| billStructure.cycleSpecification | object | An attachment by value or by reference. | N |
| billStructure.cycleSpecification.id | string | Unique identifier of the billing cycle specification | N |
| billStructure.cycleSpecification.href | string | Reference of the billing cycle specification | N |
| billStructure.cycleSpecification.billingDateShift | integer | An offset of a billing/settlement date. The offset is expressed as number of days with regard to the start of the billing/settlement period. | N |
| billStructure.cycleSpecification.billingPeriod | string | A billing time period. It can be recurring, for example: week, month, quarter of year, year . | N |
| billStructure.cycleSpecification.chargeDateOffset | integer | An offset of a date through which charges previously received by the billing system will appear on the bill. The offset is expressed as number of days with regard to the start of the BillingPeriod | N |
| billStructure.cycleSpecification.creditDateOffset | integer | An offset of a date through which charges previously received by the billing system will appear on the bill. The offset is expressed as number of days with regard to the start of the BillingPeriod | N |
| billStructure.cycleSpecification.dateShift | integer | An offset of a billing/settlement date. The offset is expressed as number of days with regard to the start of the billing/settlement period. | N |
| billStructure.cycleSpecification.description | string | An explanation regarding this billing cycle specification | N |
| billStructure.cycleSpecification.frequency | string | Frequency of the billing cycle (monthly for instance) | N |
| billStructure.cycleSpecification.mailingDateOffset | integer | An offset of a customer bill mailing date. The offset is expressed as number of days with regard to the start of the BillingPeriod. | N |
| billStructure.cycleSpecification.name | string | A short descriptive name | N |
| billStructure.cycleSpecification.paymentDueDateOffset | integer | An offset of a payment due date. The offset is expressed as number of days with regard to the start of the BillingPeriod. | N |
| billStructure.cycleSpecification.@baseType | string | When sub-classing, this defines the super-class | N |
| billStructure.cycleSpecification.@schemaLocation | string | A URI to a JSON-Schema file that defines additional attributes and relationships | N |
| billStructure.cycleSpecification.@type | string | When sub-classing, this defines the sub-class entity name | N |
| billStructure.cycleSpecification.@referredType | string | The actual type of the target instance when needed for disambiguation | N |
| billStructure.format | accountRelationship.account | An attachment by value or by reference. | N |
| billStructure.presentationMedia | accountRelationship.account | A list of bill presentation media ref or values | N |
| billStructure.@baseType | string | When sub-classing, this defines the super-class | N |
| billStructure.@schemaLocation | string | A URI to a JSON-Schema file that defines additional attributes and relationships | N |
| billStructure.@type | string | When sub-classing, this defines the sub-class entity name | N |
| contact | object Array | An individual or an organization used as a contact point for a given account and accessed via some contact medium. | N |
| contact.contactName | string | A displayable name for that contact | N |
| contact.contactType | string | Type of contact (primary, secondary...) | N |
| contact.partyRoleType | string | Identifies what kind of party role type is linked to the contact (a account manager...). NA for JM | N |
| contact.contactMedium | Array | Indicates the contact medium that could be used to contact the party. | N |
| contact.contactMedium.mediumType | string | Type of the contact medium, such as: email address, telephone number, postal address, BillingAddress | N |
| contact.contactMedium.preferred | boolean | If true, indicates that is the preferred contact medium. NA for JM | N |
| contact.contactMedium.characteristic | object | Any additional characteristic(s) of this contact medium | N |
| contact.contactMedium.characteristic.city | string | City | N |
| contact.contactMedium.characteristic.contactType | string | The type of contact, for example; phone number such as mobile, fixed home, fixed office. postal address such as shipping installation | N |
| contact.contactMedium.characteristic.country | string | N | |
| contact.contactMedium.characteristic.emailAddress | string | Full email address in standard format | N |
| contact.contactMedium.characteristic.faxNumber | string | The fax number of the contact | N |
| contact.contactMedium.characteristic.phoneNumber | string | The primary phone number of the contact | N |
| contact.contactMedium.characteristic.postCode | string | Postcode | N |
| contact.contactMedium.characteristic.socialNetworkId | string | Identifier as a member of a social network | N |
| contact.contactMedium.characteristic.stateOrProvince | string | State or province | N |
| contact.contactMedium.characteristic.street1 | string | Describes the street. For liberate, It will be the Address(Separated by comma). | N |
| contact.contactMedium.characteristic.street2 | string | Complementary street description | N |
| contact.contactMedium.characteristic.@baseType | string | When sub-classing, this defines the super-class | N |
| contact.contactMedium.characteristic.@schemaLocation | string | A URI to a JSON-Schema file that defines additional attributes and relationships | N |
| contact.contactMedium.characteristic.@type | string | When sub-classing, this defines the sub-class entity name | N |
| contact.contactMedium.validFor | accountRelationship.validFor | N | |
| contact.contactMedium.@baseType | string | When sub-classing, this defines the super-class | N |
| contact.contactMedium.@schemaLocation | string | A URI to a JSON-Schema file that defines additional attributes and relationships | N |
| contact.contactMedium.@type | string | When sub-classing, this defines the sub-class entity name | N |
| contact.relatedParty | relatedParty | N | |
| contact.validFor | accountRelationship.validFor | N | |
| contact.@baseType | string | When sub-classing, this defines the super-class | N |
| contact.@schemaLocation | string | A URI to a JSON-Schema file that defines additional attributes and relationships | N |
| contact.@type | string | When sub-classing, this defines the sub-class entity name | N |
| creditLimit | object | The maximum amount of money that may be charged on an account | N |
| defaultPaymentMethod | object | N | |
| defaultPaymentMethod.id | string | Unique identifier Id of the EntityRef. | N |
| defaultPaymentMethod.href | string | Unique reference of the EntityRef | N |
| defaultPaymentMethod.name | string | Name of the EntityRef. | N |
| defaultPaymentMethod.@baseType | string | When sub-classing, this defines the super-class | N |
| defaultPaymentMethod@schemaLocation | string | A URI to a JSON-Schema file that defines additional attributes and relationships | N |
| defaultPaymentMethod.@type | string | When sub-classing, this defines the sub-class entity name | N |
| defaultPaymentMethod.@referredType | string | The actual type of the target instance when needed for disambiguation | N |
| financialAccount | object | AccountReceivable reference. An account of money owed by a party to another entity in exchange for goods or services that have been delivered or used. An account receivable aggregates the amounts of one or more party accounts (billing or settlement) owned by a given party. | N |
| financialAccount.id | string | Unique identifier Id of the EntityRef. | N |
| financialAccount.href | string | Unique reference of the EntityRef | N |
| financialAccount.name | string | Name of the EntityRef. | N |
| financialAccount.accountBalance | accountBalance | N | |
| financialAccount.@baseType | string | When sub-classing, this defines the super-class | N |
| financialAccount@schemaLocation | string | A URI to a JSON-Schema file that defines additional attributes and relationships | N |
| financialAccount.@type | string | When sub-classing, this defines the sub-class entity name | N |
| financialAccount.@referredType | string | The actual type of the target instance when needed for disambiguation | N |
| paymentPlan | object Array | Defines a plan for payment (when a party wants to spread his payments) | N |
| paymentPlan.numberOfPayments | integer | Number of payments used to spread the global payment | N |
| paymentPlan.paymentFrequency | string | Frequency of the payments, such as monthly and bimonthly | N |
| paymentPlan.planType | string | Type of payment plan | N |
| paymentPlan.priority | integer | Priority of the payment plan | N |
| paymentPlan.status | string | Status of the payment plan (effective, ineffective) | N |
| paymentPlan.paymentMethod | defaultPaymentMethod | N | |
| paymentPlan.totalAmount | accountBalance.amount | Amount paid | N |
| paymentPlan.validFor | accountRelationship.validFor | N | |
| paymentPlan.@baseType | string | When sub-classing, this defines the super-class | N |
| paymentPlan.@schemaLocation | string | A URI to a JSON-Schema file that defines additional attributes and relationships | N |
| paymentPlan.@type | string | When sub-classing, this defines the sub-class entity name | N |
| characteristic | object Array | Describes a given characteristic of an object or entity through a name/value pair. | N |
| characteristic.name | string | Name of the characteristic. "DelinquencyDays" and "DunningGroup" are added as characteristics name/value pair. For Liberate- DateOfBirth, Nationality, BillingIndicator(Billable account or not) are the possible values. | N |
| characteristic.valueType | string | Data type of the value of the characteristic | N |
| characteristic.value | any | The value of the characteristic | N |
| characteristic.@baseType | string | When sub-classing, this defines the super-class | N |
| characteristic.@schemaLocation | string | A URI to a JSON-Schema file that defines additional attributes and relationships | N |
| characteristic.@type | string | When sub-classing, this defines the sub-class entity name | N |
| relatedParty | object Array | N | |
| relatedParty.id | string | Unique identifier Id of the EntityRef. | N |
| relatedParty.href | string | Unique reference of the EntityRef | N |
| relatedParty.name | string | Name of the EntityRef. | N |
| relatedParty.role | role played by the related party | N | |
| relatedParty.@baseType | string | When sub-classing, this defines the super-class | N |
| relatedParty@schemaLocation | string | A URI to a JSON-Schema file that defines additional attributes and relationships | N |
| relatedParty.@type | string | When sub-classing, this defines the sub-class entity name | N |
| relatedParty.@referredType | string | The actual type of the target instance when needed for disambiguation | N |
| taxExemption | object Array | Proof of freedom from taxes imposed by a taxing jurisdiction. | N |
| taxExemption.certificateNumber | string | Identifier of a document that shows proof of exemption from taxes for the taxing jurisdiction. | N |
| taxExemption.issuingJurisdiction | string | Name of the taxing jurisdiction for which taxes are exempt. | N |
| taxExemption.reason | string | Reason of the tax exemption | N |
| taxExemption.validFor | accountRelationship.validFor | N | |
| taxExemption.@baseType | string | When sub-classing, this defines the super-class | N |
| taxExemption.@schemaLocation | string | A URI to a JSON-Schema file that defines additional attributes and relationships | N |
| taxExemption.@type | string | When sub-classing, this defines the sub-class entity name | N |
| @baseType | string | When sub-classing, this defines the super-class | N |
| @schemaLocation | string | A URI to a JSON-Schema file that defines additional attributes and relationships | N |
| @type | string | When sub-classing, this defines the sub-class entity name. Type of this resource is: "BillingAccount" | N |